List of Methods by Category

Forms in Digitise Apps are similar to forms in Microsoft Visual Studio and are containers of controls. At runtime, only one form can be displayed at a time.

 

 

Data access is controlled by the use of Data Sources, Custom Views and Records.

 

A Data Source is defined in App Studio and is the definition for the interface between a Target database, Web API, web service, Outlook Contacts or Appointments or a Custom Table and your mobile app. Controls on your forms are mapped to elements within the Data Sources as output or input. Output values are written to the Target data source, and input values are read from the Target data source whenever a data update or refresh call is made on a Data Source.

A Custom View is also defined in App Studio and provides a window onto the data stored locally on the mobile device. A Custom View effectively allows you to select a set of records from all the records stored locally in your Digitise Apps Client database and to query and display the values contained within those records. The record set contained within a View is chosen using a SQL Select statement and can contain records from a single database table or combine data from multiple different tables. The record set within a View is not physically stored in its own separate table. You can use a Custom View in place of a Data Source in Data Access Methods which aren't related to or don't perform data transfers, record updates or new record creation.

 

You must define any Data Source or Custom View within App Studio before you can reference it within the Script Methods.

 

Many of the Data Access Methods require you to specify one or more Data Sources or Custom Views as parameters to the Method.

Unless stated otherwise in the Method definition, when a Method requires such a parameter, you specify it as follows:

 

ADO Database Data Sources <datasourcename>.<tablename>

 

Web Services Data Sources <datasourcename>

 

Custom Tables Custom.<tablename>

 

Custom View Custom.<viewname>

 

Outlook Contacts and Appointments
(Predefined Data Sources) <datasourcename>.<tablename>
e.g. Outlook.Contact, Outlook.Appointments

 

where:

• <datasourcename> is the Name of a Data Source as defined within App Studio.

• <tablename> is the name of the Table within the Data Source.

 

In all Methods which take a Data Source parameter, you can specify the parameter as a string value or specify a variable, either of which must contain the Data Source name in the appropriate format from the list above.

 

 

 

The Date and Time Methods behave in a similar way to their VBScript equivalents.

If you are upgrading from a version of Digitise Apps' predecessor MX, these Methods were updated in MX v10 to provide consistency across all Platforms. If you have MX apps created in earlier versions of MX you can retain the previous method of operation using the Use Cross-Platform Date Functions Property in the Project Properties. If this Property is set to True, the newer Methods will be used. If set to False, the older Methods will be used. By default, this Property is set to True for new Projects (and those upgraded from MX v10 or later) and False for Projects created in a version of App Studio pre-MX v10.

 

Hour Obtain the hour value from a date\time string.

Minute Obtain the minute value from a date\time string.

Second Obtain the seconds value from a date\time string.

Weekday Obtain the day of the week value from a date string and return as a number from 1 to 7.

Day Obtain the day of the month value from a date\time string, in numeric format.

Month Obtain the month value from a date\time string, in numeric format.

Year Obtain the year value from a date\time string.

WeekdayName Return the name of a day of the week from its numerical equivalent.

MonthName Return the name of a month from its numerical equivalent.

DateAdd Add a time interval to a date string.

DateDiff Calculate the time interval between two date strings.

DatePart Obtain a specified part of a date string.

IsDate Check whether a string contains a date.

Now Obtain the current system date and time.

 

The parameters to these Methods can be expressed as a number, a variable or a call to another Method. You can also use the Arithmetic Operators within an individual parameter expression. Floating point numbers are supported.

Digitise Apps doesn't require variables to be declared with a specific data type, such as string, long, double etc. Consequently, in the Method definitions the return value is not specified as a specific data type and could be an integer or a floating point positive or negative number.

 

Abs Obtain the absolute value of a number.

Fix Obtain the integer part of a number.

Round Round a number to a specified number of decimal places.

Rnd Randomly generate a number.

Sqr Obtain the square root of a number.

Pow Raise one number to the power of another.

Exp Obtain e raised to a specified power.

Log Obtain the natural logarithm of a number.

Sin Obtain the sine of an angle.

Cos Obtain the cosine of an angle.

Tan Obtain the tangent of an angle.

Atn Obtain the arctangent of an angle.

 

Chr Convert a decimal value to a character.

IsAlpha Check whether a string contains only alphabetic characters.

IsDigit Check whether a string contains only numeric characters.

IsNumeric Checks whether a string contains a decimal numeric value.

IsWhitespace Check whether a string contains only whitespace characters.

IsNull Checks whether a string, variable or expression is equal to NULL.

Len Count the number of characters in a string.

Left Return part of a string starting from the beginning

Mid Return part of a string starting from a specified position.

Right Return part of a string starting from the right-hand end.

LTrim Remove whitespace characters from the left-hand side of a string.

RTrim Remove whitespace characters from the right-hand side of a string.

Trim Remove whitespace characters from both ends of a string.

LCase Convert a string to lower-case.

UCase Convert a string to upper-case.

Instr Check for the first occurrence of one string within another starting at beginning of string.

InStrRev Check for the first occurrence of one string within another starting at end of string.

Replace Replace all or part of a string with another string.

StrReverse Reverse a string.

String Returns a string consisting of a repeating character.

RegEx Allows you to compare a string against a 'regular expression'.

 

GPSStart Open a COM Port and start reading GPS data.

GPSStop Close a GPS COM Port and stop reading GPS data.

GetGPSState Check the current state of the GPS port and whether a valid Fix is available.

GetGPSValue Take GPS reading.

 

SetApplicationOption Specify various settings which affect how the camera and progress bar operate.

GetApplicationOption Obtain the value of an application option set using SetApplicationOption.

GetDeviceType Query the type of device the Digitise app is running on.

GetUser Find the currently logged-in user.

GetApplicationName Obtain the name of the current Digitise app.

GetCurrentNetworkType Query the type of network currently in use.

GetCurrentServer Obtain the address details of the machine running the App Server you are connected to.

GetDeviceName Obtain the device's name.

GetDeviceId Obtain the device's ID.

GetSystemInfo Obtain version information or screen size and orientation.

IsNetworkAvailable Check to see whether the network is available.

IsServerAvailable Check to see whether an App Server is available.

MsgBox Display a message box.

GetDeviceCapabilities Check whether device has a Camera and GPS support.

TakePhoto Allow the user to take a photo.

ScanBarCode Scan a Bar Code.

DeleteFile Delete a file on the mobile device.

DeleteFolder Delete a Folder on the device

Exec Execute a command.

LaunchApplication Run another Digitise app from within the currently running Digitise app.

GetStartupParameter Obtain the parameter string passed to a Digitise app launched by another Digitise app.

PlaySound Play a wav file.

SendEmail Send an e-mail.

SendSMS Send a text message.

GetTelephoneNumber Obtain telephone number from SIM card.

DialTelephone Dial a telephone number.

Vibrate Make the device vibrate.

GetBatteryLevel Check the current battery level.

ScaleDataSourceImage Create a scaled version of an image.

WriteFile Append a string to a file.

AddSystemNotification Display Alerts and Reminders.

RemoveSystemNotification Cancel a previously configured alert or reminder.

GetPushNotificationPayload Obtain the data contained in the value field associated with the specified key from the JSON payload contained in a push notification.

GetPushToken Obtain the current push token value.

RegisterForPush Attempt to register an app with the appropriate push notification service for the type of Device.

CreateHash Create a hash value from a specified string.

GetAccessToken Obtain the OAuth Access Token for the currently logged in user.

SetDataErrorOn Turn data error reporting on.

SetDataErrorOff Turn data error reporting off.

GetLastError Obtain information about the last error which occurred.

GetLastErrorLine Obtain Script line on which the last error occurred.

GetLastErrorType Obtain category of error for the last error which occurred.

GetLastDataError Obtain information about the last data error which occurred.

ExitApplication Close the current Digitise app.

ExitClient Close all running Digitise apps and then close down the Digitise Apps Client.